Skip to content

Conversation

@woodruffw
Copy link
Member

This cleans up the README in a few important ways:

  • Moves the CLI docs below the API docs, and emphasizes that they're for experimentation and not integration.
  • Adds annotations/callouts throughout where appropriate.
  • Updates the library usage examples.

See #55.

Signed-off-by: William Woodruff <william@trailofbits.com>
@woodruffw woodruffw added the component:documentation 📖 Improvements or additions to documentation label Oct 7, 2024
@woodruffw woodruffw requested a review from facutuesca October 7, 2024 14:54
@woodruffw woodruffw self-assigned this Oct 7, 2024
Copy link
Collaborator

@facutuesca facutuesca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@woodruffw woodruffw merged commit 4a0425f into main Oct 7, 2024
4 checks passed
@woodruffw woodruffw deleted the ww/readme branch October 7, 2024 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component:documentation 📖 Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants